/*
* Copyright (c) 2011 Norbert Kopcsek
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.modulr.bundle {

	public class RequiredBundle {

		//------------------------------------------------------------------------------
		//
		//   Constructor 
		//
		//------------------------------------------------------------------------------

		public function RequiredBundle( bundleId:String = null, optional:Boolean = false, lazy:Boolean = false ) {
			this.bundleId = bundleId;
			this.optional = optional;
			this.lazy = lazy;
		}

		//------------------------------------------------------------------------------
		//
		//   Properties (Getter/Setter) 
		//
		//------------------------------------------------------------------------------

		//--------------------------------------
		// bundleId 
		//--------------------------------------

		/**
		 * The id of the required bundle.
		 */
		public function get bundleId():String {
			return _bundleId;
		}

		public function set bundleId( value:String ):void {
			_bundleId = value;
		}

		//--------------------------------------
		// optional 
		//--------------------------------------

		/**
		 * Whether or not the required bundle is optional.
		 * An optional dependency is only loaded if the bundle is available.
		 */
		public function get optional():Boolean {
			return _optional;
		}

		public function set optional( value:Boolean ):void {
			_optional = value;
		}

		//--------------------------------------
		// lazy 
		//--------------------------------------

		/**
		 * Whether or not the required bundle is lazy.
		 * A lazy dependency has to be acivated by through the bundle context.
		 */
		public function get lazy():Boolean {
			return _lazy;
		}

		public function set lazy( value:Boolean ):void {
			_lazy = value;
		}

		//--------------------------------------
		// bundle 
		//--------------------------------------

		/**
		 * The actual required bundle.
		 */
		public function get bundle():Bundle {
			return _bundle;
		}

		public function set bundle( value:Bundle ):void {
			_bundle = value;
		}

		//------------------------------------------------------------------------------
		//
		//   Protected fields 
		//
		//------------------------------------------------------------------------------

		/**
		 * @private
		 */
		protected var _bundleId:String;

		/**
		 * @private
		 */
		protected var _optional:Boolean;

		/**
		 * @private
		 */
		protected var _lazy:Boolean;

		/**
		 * @private
		 */
		protected var _bundle:Bundle;
	}
}